Skip to content

[OAS] Add description and response examples to /api/status#267355

Merged
TinaHeiligers merged 5 commits intoelastic:mainfrom
TinaHeiligers:oas/api-status-description-examples
May 5, 2026
Merged

[OAS] Add description and response examples to /api/status#267355
TinaHeiligers merged 5 commits intoelastic:mainfrom
TinaHeiligers:oas/api-status-description-examples

Conversation

@TinaHeiligers
Copy link
Copy Markdown
Contributor

@TinaHeiligers TinaHeiligers commented May 3, 2026 •
edited by kibanamachine
Loading

Summary

Adds an operation description and response examples to GET /api/status.

kbn-validate-oas flags three errors for missing operation description, missing examples on the 200 response, and missing examples on the 503 response.

This PR adds them.

Note:
The original issue framed this as a discriminator gap at the time of opening the issue.
With recent work, the validator's actual signal is now missing description plus examples.

Fixes #265889
Relates to #256462

How to test this 
node scripts/validate_oas_docs.js --skip-printing-issues --path /api/status

Should report 0 errors on both kibana.yaml and kibana.serverless.yaml.

Checklist

  • This was checked for breaking HTTP API changes; no breaking changes (additive OAS metadata only).

Identify risks

Low risk: additive OAS metadata describing what the handler already returns.

Risk Severity Likelihood Mitigation
Example payloads diverge from the runtime response shape Low Low Examples mirror fullStatusResponse and are colocated with the route, so future shape changes surface in review

Co-Authored-By: Claude Opus 4.7

@TinaHeiligers TinaHeiligers added Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// release_note:skip Skip the PR/issue when compiling release notes backport:version Backport to applied version labels v9.4.0 labels May 3, 2026
@TinaHeiligers TinaHeiligers marked this pull request as ready for review May 3, 2026 23:19
@TinaHeiligers TinaHeiligers requested review from a team as code owners May 3, 2026 23:19
@infra-vault-gh-plugin-prod
Copy link
Copy Markdown

infra-vault-gh-plugin-prod Bot commented May 3, 2026

Pinging @elastic/kibana-core (Team:Core)

florent-leborgne
florent-leborgne approved these changes May 4, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for docs

@TinaHeiligers TinaHeiligers enabled auto-merge (squash) May 5, 2026 14:00
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented May 5, 2026

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #38 / integrations When in the Fleet application and on the Endpoint Integration details page should display the endpoint custom content

Metrics [docs]

✅ unchanged

History

@TinaHeiligers TinaHeiligers merged commit 6f13fd2 into elastic:main May 5, 2026
24 checks passed
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented May 5, 2026

Starting backport for target branches: 9.4

https://github.com/elastic/kibana/actions/runs/25384526705

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented May 5, 2026

💔 All backports failed

Status Branch Result
❌ 9.4 Backport failed because of merge conflicts

You might need to backport the following PRs to 9.4:
- [OAS][Detection Engine] Clean up remaining errors (#266228)
- Fix OAS validation errors in entity analytics privilege monitoring APIs && Risk Score APIs (#265470)
- [OAS] Improve spec descriptions, summaries, examples (#265153)
- [Cases][Docs] - Add additional examples and cleanup to openApi (#263617)
- [Entity Analytics] Add missing OpenAPI descriptions and examples to p… (#264778)

Manual backport

To create the backport manually run:

node scripts/backport --pr 267355

Questions ?

Please refer to the Backport tool documentation

@kibanamachine kibanamachine mentioned this pull request May 5, 2026
Merged
2 tasks
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label May 7, 2026
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented May 7, 2026

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 267355 locally
cc: @TinaHeiligers

1 similar comment
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented May 8, 2026

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 267355 locally
cc: @TinaHeiligers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jloleysens jloleysens jloleysens approved these changes

@florent-leborgne florent-leborgne florent-leborgne approved these changes

Assignees

No one assigned

Labels

backport missing Added to PRs automatically when the are determined to be missing a backport. backport:version Backport to applied version labels release_note:skip Skip the PR/issue when compiling release notes Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// v9.4.0 v9.5.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[OAS Validation] Fix structural schema issues on /api/status

4 participants

@TinaHeiligers @kibanamachine @jloleysens @florent-leborgne